Skip to main content

SOA Traces

Overview

When configuring SOA invocations in Bizagi, you may rely on the use of traces for error control and diagnostics.

Traces let you detect whenever there is an issue with the SOA invocation and retrieve further detail.


SOA Traces

Whenever you are debugging an SOA invocation (in Development environments) or whenever you wish to retrieve further detail about a failed invocation, you may choose to turn on the SOA traces.

SOA Trace Example

Note
Keep in mind that SOA traces can be enabled anytime, but it is strongly recommended to enable them temporarily only when needed (and afterwards, disable them).
Changes in this configuration will most likely require a reset in your Bizagi server's services.

Enabling these traces is useful to track down, after an error in the application, the exact point where said error has happened. There are five points where detail is logged and you may diagnose if there is a problem with your bot's invocation, or whenever transformations were being applied to the information.


Types of Traces

SOA traces are divided into three categories for the following methods:

  • EntityManagerSOA
  • WorkflowEngineSOA
  • QuerySOA

The following traces are logged in chronological order, as detailed in the tables below:


Entity Manager

Chronological OrderTrace TypeDescription
1RequestCreates a .log file with the inputs sent to the robot before the execution of its logic.
Name convention: BizagiAPI_SOA_EntityManager_Request[TimeStamp].log
Timestamp format: yyMMddHHmmss
2ResponseCreates a .log file with the outputs received from the robot before any transformation done by Bizagi.
Name convention: BizagiAPI_SOA_EntityManager_Response[TimeStamp].log
Timestamp format: yyMMddHHmmss

Workflow Engine

Chronological OrderTrace TypeDescription
1RequestCreates a .log file with the inputs sent to the robot before the execution of its logic.
Name convention: BizagiAPI_SOA_WorkFlowManager_Request[TimeStamp].log
Timestamp format: yyMMddHHmmss
2ResponseCreates a .log file with the outputs received from the robot before any transformation done by Bizagi.
Name convention: BizagiAPI_SOA_WorkFlowManager_Response[TimeStamp].log
Timestamp format: yyMMddHHmmss

Query

Chronological OrderTrace TypeDescription
1RequestCreates a .log file with the inputs sent to the robot before the execution of its logic.
Name convention: BizagiAPI_SOA_QueryManager_Request[TimeStamp].log
Timestamp format: yyMMddHHmmss
2ResponseCreates a .log file with the outputs received from the robot before any transformation done by Bizagi.
Name convention: BizagiAPI_SOA_QueryManager_Response[TimeStamp].log
Timestamp format: yyMMddHHmmss